<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilloader: xloader_intr.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilloader
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xloader__intr_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xloader_intr.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the code related to the interrupt handling. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
</p>
<hr/>
<p>
1.00  kc   03/25/2019 Initial release
1.01  kc   04/09/2019 Added support for PCIe secondary boot mode and
                                        partial PDI load
      kc   09/13/2019 SBI reset is removed for SMAP boot mode to ensure smap
                                        bus width value remains unchanged
1.02  kc   02/17/2020 Added APIs to add services to task queues in interrupt
                                        context
      kc   06/03/2020 Moved PLM GIC interrupt enablement to GIC handlers
      bsv  04/09/2020 Code clean up of Xilloader
      bsv  08/12/2020 Remove misleading comments
      td   08/19/2020 Fixed MISRA C violations Rule 10.3
      bm   10/14/2020 Code clean up
      ana  10/19/2020 Added doxygen comments
1.03  bsv  07/19/2021 Disable UART prints when invalid header is encountered
                      in slave boot modes
      bsv  08/02/2021 Updated function return type as part of code clean up
      bsv  09/05/2021 Disable prints in slave boot modes in case of error
1.06  am   11/24/2021 Fixed doxygen warnings
1.07  ma   05/10/2022 Enable SSIT interrupts for Slave SLRs
      bm   07/06/2022 Refactor versal and versal_net code
      bm   07/18/2022 Shutdown modules gracefully during update
      bm   07/24/2022 Set PlmLiveStatus during boot time
1.08  ng   11/11/2022 Updated doxygen comments
      bm   01/03/2023 Switch to SSIT Events as soon as basic Noc path is
                      configured
      sk   02/22/2023 Added EoPDI SYNC logic to handle Slave PDI load errors
      ng   03/30/2023 Updated algorithm and return values in doxygen comments
      sk   05/18/2023 Deprecate copy to memory feature,removed SubsystemPdiIns
      sk   08/18/2023 Fixed security review comments
      dd         09/11/2023 MISRA-C violation Rule 17.7 fixed
      sk   03/13/24 Fixed doxygen comments format
      pre  03/02/2025 Added task based event notification functionality for partial PDI
      nb   04/09/2025 Add CPM PCIE isolation removal which has to come after
                      PDI load is complete
      pre  05/10/2025 Added AES and SHA events queuing mechanism under XPLMI_IPI_DEVICE_ID macro</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga08ffba6e00178b279c6c2e8f162408cb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__server__apis.html#ga08ffba6e00178b279c6c2e8f162408cb">XLOADER_SBI_DELAY_IN_MICROSEC</a>&#160;&#160;&#160;(5000U)</td></tr>
<tr class="memdesc:ga08ffba6e00178b279c6c2e8f162408cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag indicates SBI delay in micro second.  <a href="group__xloader__server__apis.html#ga08ffba6e00178b279c6c2e8f162408cb">More...</a><br/></td></tr>
<tr class="separator:ga08ffba6e00178b279c6c2e8f162408cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga90289e1764cf2d23465bfe018e6b5f84"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__server__apis.html#ga90289e1764cf2d23465bfe018e6b5f84">XLOADER_LOG_LEVEL_MASK</a>&#160;&#160;&#160;(0xF0U)</td></tr>
<tr class="memdesc:ga90289e1764cf2d23465bfe018e6b5f84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag indicates Log level mask.  <a href="group__xloader__server__apis.html#ga90289e1764cf2d23465bfe018e6b5f84">More...</a><br/></td></tr>
<tr class="separator:ga90289e1764cf2d23465bfe018e6b5f84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba57a821125a6b7a593b065430132fdf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__server__apis.html#gaba57a821125a6b7a593b065430132fdf">XLOADER_SBI_CTRL_INTERFACE_AXI_SLAVE</a>&#160;&#160;&#160;(0x8U)</td></tr>
<tr class="memdesc:gaba57a821125a6b7a593b065430132fdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">SBI PCIE PDI load.  <a href="group__xloader__server__apis.html#gaba57a821125a6b7a593b065430132fdf">More...</a><br/></td></tr>
<tr class="separator:gaba57a821125a6b7a593b065430132fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga11387289357f0d56f5ee8f21f16aba70"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__server__apis.html#ga11387289357f0d56f5ee8f21f16aba70">XLoader_IntrInit</a> (void)</td></tr>
<tr class="memdesc:ga11387289357f0d56f5ee8f21f16aba70"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the loader instance and registers loader commands with PLM.  <a href="group__xloader__server__apis.html#ga11387289357f0d56f5ee8f21f16aba70">More...</a><br/></td></tr>
<tr class="separator:ga11387289357f0d56f5ee8f21f16aba70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb988cc645f5d3b315b8eba734ab65d8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__intr_8c.html#afb988cc645f5d3b315b8eba734ab65d8">XLoader_PpdiEventHandling</a> (<a class="el" href="xloader_8h.html#a1b158ce0f453a76bb3cf394a719e1828">PdiSrc_t</a> PdiSrc, u64 PdiAddr, u32 IpiMask)</td></tr>
<tr class="memdesc:afb988cc645f5d3b315b8eba734ab65d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function handles the partial PDI event based on status of resources and is applicable only when queuinh mechanism is enabled.  <a href="#afb988cc645f5d3b315b8eba734ab65d8">More...</a><br/></td></tr>
<tr class="separator:afb988cc645f5d3b315b8eba734ab65d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab95ab788a5e95180a0593bae5cd039b6"><td class="memItemLeft" align="right" valign="top">XSecure_PartialPdiEventParams *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xloader__intr_8c.html#ab95ab788a5e95180a0593bae5cd039b6">XLoader_PpdiEventParamsPtr</a> (void)</td></tr>
<tr class="memdesc:ab95ab788a5e95180a0593bae5cd039b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to get the functions related to partial PDI event.  <a href="#ab95ab788a5e95180a0593bae5cd039b6">More...</a><br/></td></tr>
<tr class="separator:ab95ab788a5e95180a0593bae5cd039b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="afb988cc645f5d3b315b8eba734ab65d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XLoader_PpdiEventHandling </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="xloader_8h.html#a1b158ce0f453a76bb3cf394a719e1828">PdiSrc_t</a>&#160;</td>
          <td class="paramname"><em>PdiSrc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u64&#160;</td>
          <td class="paramname"><em>PdiAddr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IpiMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function handles the partial PDI event based on status of resources and is applicable only when queuinh mechanism is enabled. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">PdiPtr</td><td>is the instance pointer that points to PDI details </td></tr>
    <tr><td class="paramname">PdiSrc</td><td>is source of PDI. </td></tr>
    <tr><td class="paramname">PdiAddr</td><td>is the address at which PDI is located in the PDI source</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS </li>
</ul>
</dd></dl>

</div>
</div>
<a class="anchor" id="ab95ab788a5e95180a0593bae5cd039b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XSecure_PartialPdiEventParams* XLoader_PpdiEventParamsPtr </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to get the functions related to partial PDI event. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>NULL </li>
</ul>
</dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
